# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Path setup --------------------------------------------------------------

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.

from enum import auto
import os
import sys

from sphinx.ext import autodoc

sys.path.insert(0, os.path.abspath("../.."))

import docs.pygments_extension
import docs.sphinx_patch


# -- Project information -----------------------------------------------------

project = "XTuner"
copyright = "2024, XTuner Contributors"
author = "XTuner Contributors"

# The full version, including alpha/beta/rc tags
version_file = "../../xtuner/version.py"
with open(version_file) as f:
    exec(compile(f.read(), version_file, "exec"))
__version__ = locals()["__version__"]
# The short X.Y version
version = __version__
# The full version, including alpha/beta/rc tags
release = __version__

# -- General configuration ---------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
    "sphinx.ext.napoleon",
    "sphinx.ext.viewcode",
    "sphinx.ext.intersphinx",
    "sphinx_copybutton",
    "sphinx.ext.autodoc",
    "sphinx.ext.autosummary",
    "myst_parser",
    "sphinxarg.ext",
    "sphinx_togglebutton",
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]

# Exclude the prompt "$" when copying code
copybutton_prompt_text = r'>>> |\.\.\. '
copybutton_prompt_is_regexp = True


language = "en"

# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#
html_theme = "sphinx_book_theme"
html_logo = "_static/image/logo.png"
html_theme_options = {
    "path_to_docs": "docs/en",
    "repository_url": "https://github.com/InternLM/xtuner",
    "use_repository_button": True,
    "pygments_light_style": "xtuner-emacs",
    "pygments_dark_style": "xtuner-dracula",
    "use_sidenotes": True,
}
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]
html_css_files = ["custom.css"]

# Mock out external dependencies here.
autodoc_mock_imports = [
    "pydantic",
    "deepspeed",
    "ray",
    "transformers",
    "torch",
    "mmengine",
    "tqdm",
    "numpy",
    "cyclopts",
    "safetensors",
    "loguru",
    "datasets",
    "scikit-image",
    "scipy"
    "torchvision",
    "xxhash",
    "timm",
    "imageio",
    "torchvision",
    "httpx",
    "cv2",
    "addict",
    "torchvision",
    "PIL",
    "uvicorn",
    "fastapi",
]



# class MockedClassDocumenter(autodoc.ClassDocumenter):
#     """Remove note about base class when a class is derived from object."""
#
#     def add_line(self, line: str, source: str, *lineno: int) -> None:
#         if line == "   Bases: :py:class:`object`":
#             return
#         super().add_line(line, source, *lineno)
#
#
# autodoc.ClassDocumenter = MockedClassDocumenter

navigation_with_keys = False


